UTILS.h

Go to the documentation of this file.

#ifndef _UTILS_H
#define _UTILS_H

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BITS_IN_16
 #define BITS_IN_16 (16u)
#endif
#ifndef BITS_IN_24
 #define BITS_IN_24 (24u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef MSB_8_BITS
 #define MSB_8_BITS  (0x80u)
#endif
#ifndef MSB_MINUS_ONE
 #define MSB_MINUS_ONE  (0x07u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif


/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/*** Enums ***/

/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Extern ***/

/*** Globals ***/

/*** Static Globals ***/

/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
 /*
 ******************************************************************************
 *
 * Function:          u8fnCheckOddParity()
 *
 */
uint8_t  u8fnCheckOddParity(uint8_t u8Byte, uint8_t u8ParityPosition);
 /*
 ******************************************************************************
 *
 * Function:          u16fnCheckOddParity()
 *
 */
uint16_t u16fnCheckOddParity(uint16_t u16Word, uint16_t u16ParityPosition);
/*
******************************************************************************
*
* Function:          u32fnCheckOddParity()
*
*/
uint32_t u32fnCheckOddParity(uint32_t u32Word, uint32_t u32ParityPosition);
/*
******************************************************************************
*
* Function:          u8fnCRC8()
*
*/
uint8_t u8fnCRC8(const uint8_t* pu8Buffer, 
                 uint8_t u8Poly, 
                 uint8_t u8MBitsize,
                             uint8_t u8Remainder);
/*
 ******************************************************************************
 *
 * Function:          vfnASCIIByteToHex()
 *
 */
void vfnASCIIByteToHex(uint8_t* pu8Source, uint8_t* pu8Target, \
                       uint16_t u16NOfBytes);
/*
 ******************************************************************************
 *
 * Function:          vfnHexToASCIIMaskToList()
 *
 */
void vfnHexToASCIIMaskToList(const uint16_t cu16MaskList,
                             uint8_t* pau8DataArray,
                             uint16_t* pu16Index,
                             const uint16_t cu16Mask);
/*
 ******************************************************************************
 *
 * Function:          u8fnUnitASCIIToHex()
 *
 */
static uint8_t u8fnUnitASCIIToHex(const uint8_t u8ASCIIData);
/*
 ******************************************************************************
 *
 * Function:          vfnHexToASCII()
 *
 */
void vfnHexToASCII(uint8_t* pu8Source, uint8_t* pu8Target, \
                   uint16_t u16NOfBytes);
/*
 ******************************************************************************
 *
 * Function:          u8fnUnitHexToASCII()
 *
 */
static uint8_t u8fnUnitHexToASCII(uint8_t u8HexData);
/*
 ******************************************************************************
 *
 * Function:          vfnCopyArray()
 *
 */
void vfnCopyArray(uint8_t* pu8Source, uint8_t* pu8Target, \
                  uint16_t u16NOfBytes);
/*
 ******************************************************************************
 *
 * Function:          u16fnMaxU16DeltaInArray()
 *
 */
uint16_t u16fnMaxU16DeltaInArray(const uint16_t* au16Array, 
                                 uint8_t u8ArraySize);
/*
 ******************************************************************************
 *
 * Function:          u32fnDiffAbsoluteValue()
 *
 */
uint32_t u32fnDiffAbsoluteValue(uint32_t au32Value1, uint32_t au32Value2);
#endif /* _FILENAME_H */